Support Linstor Primary Storage for NAS BnR by abh1sar · Pull Request #12796 · apache/cloudstack

abh1sar · 2026-03-12T06:33:30Z

Description

This PR fixes #12218

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Backup from Linstor Primary Storage to NAS NFS backup repository
Restore from Backup to Linstor Primary Storage
Create new Instance from Backup to Linstor Primary Storage
Restore Backup to NFS Primary Storage
Create new Instance from Backup to NFS Primary Storage

Validated Data after Restore.

How did you try to break this feature and the system with this change?

codecov · 2026-03-12T06:41:28Z

Codecov Report

❌ Patch coverage is 21.62162% with 58 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.60%. Comparing base (4708121) to head (0f5e9d6).

Files with missing lines	Patch %	Lines
...ce/wrapper/LibvirtRestoreBackupCommandWrapper.java	29.62%	34 Missing and 4 partials ⚠️
...rg/apache/cloudstack/backup/NASBackupProvider.java	0.00%	14 Missing ⚠️
...apache/cloudstack/backup/RestoreBackupCommand.java	0.00%	6 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.22   #12796      +/-   ##
============================================
- Coverage     17.60%   17.60%   -0.01%     
  Complexity    15677    15677              
============================================
  Files          5918     5918              
  Lines        531681   531727      +46     
  Branches      65005    65016      +11     
============================================
- Hits          93623    93620       -3     
- Misses       427498   427545      +47     
- Partials      10560    10562       +2

Flag	Coverage Δ
uitests	`3.70% <ø> (ø)`
unittests	`18.67% <21.62%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sureshanaparti · 2026-03-12T07:37:34Z

plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java

-            volumePathPrefix = storagePool.getPath();
+            volumePathPrefix = storagePool.getPath() + "/";
+        } else if (Storage.StoragePoolType.Linstor.equals(storagePool.getPoolType())) {
+            volumePathPrefix = "/dev/drbd/by-res/cs-";


can keep this path in LinstorUtil, and use it here

Can't access LinstorUtil from here.

sureshanaparti · 2026-03-12T07:41:52Z

Hi @rp- Can you perform some tests with this PR changes and confirm?

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java

abh1sar · 2026-03-14T15:53:58Z

@blueorangutan package

blueorangutan · 2026-03-14T15:56:03Z

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-03-14T17:04:59Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17143

rp- · 2026-03-16T10:38:34Z

Hi @rp- Can you perform some tests with this PR changes and confirm?

I created a test cluster and also tested the backup nfs.
Everything worked as expected, I only noticed that the backup .qcow2 file took the FULL space, so it looks like there is no zero discard happening. Is there a way to tell qemu/libvirt to use zero-discard while creating the backup image?

Or would it be possible to later use qemu-img convert -c or virt-sparsify on the backup?
btw. virt-sparsify only worked without using the --in-place option, but then the savings are huge 414M vs. 8GB, also the qemu-img compress gives 527M vs. 8GB.

Maybe also @sbrueseke wants to check this out

sbrueseke · 2026-03-17T12:09:44Z

As far as I understand the backup framework, it uses virsh for running instances and qemu-img for stopped instances. Is this correct? So for stopped instances adding a -c parameter would be easy and would make sense to me. But virsh does not have a parameter for compression, at least not that I am aware of.
Compressing the backup data is a goal we should achieve.

rp- · 2026-03-17T13:17:55Z

As far as I understand the backup framework, it uses virsh for running instances and qemu-img for stopped instances. Is this correct? So for stopped instances adding a -c parameter would be easy and would make sense to me. But virsh does not have a parameter for compression, at least not that I am aware of. Compressing the backup data is a goal we should achieve.

@sbrueseke 😆 Thank you for thinking, but I actually just wanted to make you aware of this PR and maybe you want to test it.

Co-authored-by: Abhisar Sinha <63767682+abh1sar@users.noreply.github.com>

abh1sar · 2026-04-05T12:25:38Z

@rp- is this PR good to go from your side?
There is another open PR which is adding compression support for NAS backup #12898 which will handle the backup file bloat.

abh1sar · 2026-04-05T12:25:44Z

@blueorangutan package

blueorangutan · 2026-04-05T12:26:04Z

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-05T13:25:24Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17360

abh1sar · 2026-04-06T03:28:51Z

@blueorangutan test

blueorangutan · 2026-04-06T03:30:03Z

@abh1sar a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2026-04-06T18:37:51Z

[SF] Trillian test result (tid-15811)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 51470 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12796-t15811-kvm-ol8.zip
Smoke tests completed. 149 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

rp-

Except for the large backup .qcow2 I have no further objections.

sureshanaparti · 2026-04-07T05:48:27Z

Except for the large backup .qcow2 I have no further objections.

@rp- @abh1sar any doc update is required for large backups?

sureshanaparti

clgtm

abh1sar · 2026-04-07T06:17:48Z

Except for the large backup .qcow2 I have no further objections.

I did some testing and found out that qemu-img convert -O used for stopped VM backups doesn't bloat the space.
So for running VMs I added code in nasbackup.sh to use qemu-img convert -O on the backup file by creating a temp file and then replacing it with the backup file.

There is no other way to avoid this with virsh backup-begin, so our best bet is to release the storage space after backup file is created.

@rp- would you be able to verify the fix so that we can merge this in 4.22.1 before the freeze this Friday? Thanks.

abh1sar · 2026-04-07T06:18:30Z

@blueorangutan package

Copilot

Pull request overview

This PR addresses issue #12218 by aligning NAS backup/restore behavior with how Linstor-backed volumes are identified and addressed on KVM hosts, enabling successful restore / create-from-backup workflows when the target primary storage is Linstor.

Changes:

Update KVM NAS backup script to name backup qcow2 files using the Linstor volume UUID (derived from /dev/drbd/by-res/cs-<uuid>/0) and add a post-backup sparsification step for Linstor-backed disks.
Extend KVM restore wrapper logic to correctly derive volume UUIDs for Linstor paths, restore to Linstor block devices, and attach Linstor volumes as RAW disks.
Add restoreVolumeSizes to RestoreBackupCommand and plumb it through NAS restore flows (with test updates to satisfy the new command shape).

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
scripts/vm/hypervisor/kvm/nasbackup.sh	Adjusts backup naming for Linstor block devices and adds a Linstor qcow2 re-sparsification step.
plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java	Builds correct restore paths for Linstor (`/dev/drbd/by-res/cs-<id>/0`) and sends restore volume sizes.
core/src/main/java/org/apache/cloudstack/backup/RestoreBackupCommand.java	Adds `restoreVolumeSizes` field to carry target volume sizing info to the agent.
plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java	Adds Linstor-aware UUID extraction, block-device restore handling, and RAW attach for Linstor.
plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapperTest.java	Updates mocks for new command fields/pool type requirements.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

scripts/vm/hypervisor/kvm/nasbackup.sh

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java

plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java

abh1sar · 2026-04-07T09:32:18Z

@blueorangutan package

blueorangutan · 2026-04-07T09:34:04Z

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-07T10:34:33Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17385

rp- · 2026-04-07T13:34:48Z

Except for the large backup .qcow2 I have no further objections.

I did some testing and found out that qemu-img convert -O used for stopped VM backups doesn't bloat the space. So for running VMs I added code in nasbackup.sh to use qemu-img convert -O on the backup file by creating a temp file and then replacing it with the backup file.

There is no other way to avoid this with virsh backup-begin, so our best bet is to release the storage space after backup file is created.

@rp- would you be able to verify the fix so that we can merge this in 4.22.1 before the freeze this Friday? Thanks.

Just tested it now and looks good.
Online-backups get compacted afterwards.

boring-cyborg bot added component:backup component:kvm labels Mar 12, 2026

abh1sar requested a review from sureshanaparti March 12, 2026 06:33

sureshanaparti reviewed Mar 12, 2026

View reviewed changes

sureshanaparti linked an issue Mar 12, 2026 that may be closed by this pull request

Create Instance from Backup Failed #12218

Open

sureshanaparti requested a review from rp- March 12, 2026 07:40

sureshanaparti added this to the 4.22.1 milestone Mar 12, 2026

sureshanaparti added this to Apache CloudStack 4.22.1 Mar 12, 2026

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.1 Mar 12, 2026

sureshanaparti added the status:needs-testing label Mar 12, 2026

abh1sar commented Mar 13, 2026

View reviewed changes

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java Outdated Show resolved Hide resolved

abh1sar commented Mar 14, 2026

View reviewed changes

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java Outdated Show resolved Hide resolved

abh1sar added 3 commits April 5, 2026 17:54

Support Linstor Primary Storage for NAS BnR

a63827f

Apply suggestions from code review

4532248

Co-authored-by: Abhisar Sinha <63767682+abh1sar@users.noreply.github.com>

Fix UT

a671dee

abh1sar force-pushed the linstor-nas branch from 9af274b to a671dee Compare April 5, 2026 12:24

abh1sar requested a review from sureshanaparti April 5, 2026 12:26

rp- approved these changes Apr 7, 2026

View reviewed changes

sureshanaparti approved these changes Apr 7, 2026

View reviewed changes

sureshanaparti added the ready-for-testing label Apr 7, 2026

sureshanaparti requested a review from rajujith April 7, 2026 05:53

fix backup file bloat for running VMs

53c62f5

abh1sar requested a review from Copilot April 7, 2026 06:18

Copilot started reviewing on behalf of abh1sar April 7, 2026 06:19 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

review comments

0f5e9d6

Conversation

abh1sar commented Mar 12, 2026

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sureshanaparti Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

abh1sar Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Mar 12, 2026

Uh oh!

Uh oh!

Uh oh!

abh1sar commented Mar 14, 2026

Uh oh!

blueorangutan commented Mar 14, 2026

Uh oh!

blueorangutan commented Mar 14, 2026

Uh oh!

rp- commented Mar 16, 2026

Uh oh!

sbrueseke commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rp- commented Mar 17, 2026

Uh oh!

abh1sar commented Apr 5, 2026

Uh oh!

abh1sar commented Apr 5, 2026

Uh oh!

blueorangutan commented Apr 5, 2026

Uh oh!

blueorangutan commented Apr 5, 2026

Uh oh!

abh1sar commented Apr 6, 2026

Uh oh!

blueorangutan commented Apr 6, 2026

Uh oh!

blueorangutan commented Apr 6, 2026

Uh oh!

rp- left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Apr 7, 2026

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

abh1sar commented Apr 7, 2026

Uh oh!

abh1sar commented Apr 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abh1sar commented Apr 7, 2026

Uh oh!

blueorangutan commented Apr 7, 2026

Uh oh!

blueorangutan commented Apr 7, 2026

codecov bot commented Mar 12, 2026 •

edited

Loading

sbrueseke commented Mar 17, 2026 •

edited

Loading